Skip to content

build(deps): unblock TypeScript 7 API generation - #1610

Merged
FelixTJDietrich merged 1 commit into
mainfrom
1593-build-dependency-typescript-unblock
Aug 29, 2026
Merged

build(deps): unblock TypeScript 7 API generation#1610
FelixTJDietrich merged 1 commit into
mainfrom
1593-build-dependency-typescript-unblock

Conversation

@FelixTJDietrich

@FelixTJDietrich FelixTJDietrich commented Aug 29, 2026

Copy link
Copy Markdown
Collaborator

Description

Unifies the workspace on TypeScript 7.0.2 by removing the webapp's TypeScript 6 dependency and typescript7 alias. API generation moves to an exact @hey-api/openapi-ts prerelease snapshot whose renderer no longer depends on the TypeScript compiler API, so the webapp can use the normal tsc command everywhere.

The generated client is committed in full because the new renderer changes canonical formatting, declaration order, and some generated helper types. Its public operation and model exports remain intact, and a second destructive generation produced byte-identical output.

Dependency choice

Stable @hey-api/openapi-ts@0.99.0 still fails with TypeScript 7 because it reads the compiler API that the native compiler package does not expose (hey-api/hey-api#4235). This PR pins 0.0.0-next-20260824173136 exactly—rather than following the mutable next tag—and records its integrity in bun.lock. The snapshot is prerelease software; the exact pin, committed generated output, and CI drift check bound that risk until the upstream work reaches a stable release.

No operator or user action is required.

Fixes #1593
Unblocks #1466

How to test

  • bun install --frozen-lockfile
  • bun run generate:api:application-server:client and confirm webapp/src/api remains unchanged
  • bun run typecheck
  • bun run test:webapp
  • bun run build:webapp
  • bun run verify

Checklist

  • The changeset is intentionally empty because this changes build and code-generation tooling only
  • No operator action, environment change, or migration is required

Summary by CodeRabbit

  • New Features

    • Added support for client metadata and improved access to server-sent event result types.
    • API requests now use the application root as their default base URL.
    • Authentication schemes can be uniquely identified when their configurations are otherwise identical.
  • Improvements

    • Enhanced API parameter handling for optional request bodies and complex parameters.
    • Improved compatibility with the latest TypeScript and API generation tooling.
    • Added stronger type information across generated API utilities for more reliable builds and type checking.

@FelixTJDietrich
FelixTJDietrich requested a review from a team as a code owner August 29, 2026 15:25
@github-actions github-actions Bot added security Authentication, authorization, vulnerability fixes maintenance Chores, cleanup, non-functional improvements dependencies Package updates, version bumps, lock file changes webapp React app: UI components, routes, state management size:S This PR changes 10-29 lines, ignoring generated files. labels Aug 29, 2026
@coderabbitai

coderabbitai Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8f9c7827-baf0-4fa4-b18b-3a3fae2ae4ac

📥 Commits

Reviewing files that changed from the base of the PR and between 4bce941 and 5dc2a2a.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (16)
  • .changeset/typescript-seven-stands-alone.md
  • webapp/AGENTS.md
  • webapp/package.json
  • webapp/src/api/@tanstack/react-query.gen.ts
  • webapp/src/api/client.gen.ts
  • webapp/src/api/client/index.ts
  • webapp/src/api/client/utils.gen.ts
  • webapp/src/api/core/auth.gen.ts
  • webapp/src/api/core/params.gen.ts
  • webapp/src/api/core/pathSerializer.gen.ts
  • webapp/src/api/core/queryKeySerializer.gen.ts
  • webapp/src/api/core/types.gen.ts
  • webapp/src/api/core/utils.gen.ts
  • webapp/src/api/sdk.gen.ts
  • webapp/src/api/transformers.gen.ts
  • webapp/src/api/types.gen.ts

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The webapp switches to TypeScript 7 and a prerelease OpenAPI generator. Generated API code adds explicit types, exports client metadata types, sets a root base URL, updates parameter slot construction, and reformats transformers.

Changes

TypeScript 7 toolchain and generated API

Layer / File(s) Summary
TypeScript 7 and API generator configuration
.changeset/typescript-seven-stands-alone.md, webapp/package.json, webapp/AGENTS.md
Build and type-check scripts use TypeScript 7. The typescript7 alias is removed. The OpenAPI generator uses a pinned prerelease. Related documentation is renamed and shortened.
Generated client contracts and type annotations
webapp/src/api/client.gen.ts, webapp/src/api/client/index.ts, webapp/src/api/client/utils.gen.ts, webapp/src/api/core/auth.gen.ts, webapp/src/api/core/types.gen.ts, webapp/src/api/core/pathSerializer.gen.ts, webapp/src/api/core/queryKeySerializer.gen.ts, webapp/src/api/core/utils.gen.ts, webapp/src/api/transformers.gen.ts
The generated client adds ClientMeta and ServerSentEventsResult exports, types the client and serializer APIs explicitly, adds Auth.key, sets baseUrl to /, and changes transformer indentation.
Client parameter slot construction
webapp/src/api/core/params.gen.ts
Parameter construction uses explicit function declarations and return types. The request body is optional. Slot writes initialize missing slot records through writeSlot.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 5dc2a

This PR standardizes the TypeScript and API-generation toolchain while preserving the existing generated client behavior. No actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 10 files. (3 skipped: 3… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: unblocking TypeScript 7 API generation.
Linked Issues check ✅ Passed The PR removes the webapp TypeScript 6 dependency and typescript7 alias, pins the exact openapi-ts prerelease, switches build and typecheck scripts to tsc, and commits the regenerated API client. Thes…
Out of Scope Changes check ✅ Passed The changes remain within the linked issue scope. The generated API updates, formatting changes, type annotations, metadata exports, documentation update, and changeset support the TypeScript 7 and AP…
Full details: Linked Issues check

Explanation

The PR removes the webapp TypeScript 6 dependency and typescript7 alias, pins the exact openapi-ts prerelease, switches build and typecheck scripts to tsc, and commits the regenerated API client. These changes satisfy the coding requirements in issue #1593. bun.lock is excluded from review, so its integrity entry cannot be independently verified, but this does not disprove compliance.

Full details: Out of Scope Changes check

Explanation

The changes remain within the linked issue scope. The generated API updates, formatting changes, type annotations, metadata exports, documentation update, and changeset support the TypeScript 7 and API generation toolchain migration.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 10 files. (3 skipped: 3 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 1593-build-dependency-typescript-unblock

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

🧩 Storybook Preview

Preview has been removed (PR closed)

@FelixTJDietrich
FelixTJDietrich merged commit 1924374 into main Aug 29, 2026
37 checks passed
@FelixTJDietrich
FelixTJDietrich deleted the 1593-build-dependency-typescript-unblock branch August 29, 2026 21:18
@github-actions

Copy link
Copy Markdown
Contributor

📚 Documentation Preview

Preview has been removed (PR closed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Package updates, version bumps, lock file changes maintenance Chores, cleanup, non-functional improvements security Authentication, authorization, vulnerability fixes size:S This PR changes 10-29 lines, ignoring generated files. webapp React app: UI components, routes, state management

Projects

None yet

Development

Successfully merging this pull request may close these issues.

build(deps): unblock TypeScript 7 by moving API codegen off the TS compiler API

1 participant